4.5.5.4 查询应用授权-基于名称
可通过此接口基于应用的名称查询应用的授权详情。
基本信息
请求地址：
https://SDPC-IP:4433/api/v3/resourceAssign/queryByName请求方式：
POST
请求头（Header）
- 请求体（Body）
| 参数 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| name | 应用名称 | 是 | string | 应用名称 |
| fieldMode | 模式 | 是 | string | 返回字段模式 取值范围： all - 返回所有字段（默认） lite - 返回精简后的字段 |
| sortBy | 排序方式 | 是 | string | 取值范围： default - 默认排序方式，按照实体类型，用户目录id，名称的优先级进行升序排序 entityType - 按照实体类型排序 expireTime - 按照过期时间排序 effectiveTime - 按照生效时间排序 editor - 按照编辑者排序 updatedAt - 按照更新时间排序 createdAt - 按照创建时间排序 creator按照创建者排序 注意：精简模式下排序方式只能为default |
| entityType | 类型 | 否 | string[] | 取值范围： group - 组织架构 band - 角色 user - 用户 注意：传空数组或不传表示查询所有实体类型 |
| pageSize | 分页大小 | 否 | number | 查询数据会自动分页，此参数为每页包含数据的最大条数。 取值范围：0 < 分页大小 <= 5000。 默认值：20 |
| pageIndex | 分页索引 | 否 | number | 查询数据会自动分页，此参数为待查询的页面序号。 取值范围：0 < 分页索引 <= 1000000。 默认值：1 |
- 请求示例
curl --location --request POST 'https://SDPC-IP:4433/api/v3/resourceAssign/queryByName' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--data-raw '{
"name": "oa2",
"fieldMode": "all",
"sortBy": "default",
"entityType": ["user", "group", "band"]
}'
- 返回数据
| 参数 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| code | 响应码 | string | OK 表示成功，其他表示出错。具体含义请参考错误码定义 |
| data | 响应数据 | object | 响应数据 |
| ├─ count | 查询结果总数 | number | 查询结果总数 |
| ├─ pageCount | 总页数 | number | 总页数 |
| ├─ pageSize | 分页大小 | number | 分页大小 |
| ├─ pageIndex | 当前页码 | number | 当前页码 |
| ├─ data | 应用授权详情 | object [] | 应用授权详情 |
| ├─├─ id | 授权对象id | string | 用户/组织架构/角色的id |
| ├─├─ name | 授权对象名称 | string | 用户/组织架构/角色的名称 |
| ├─├─ displayName | 授权对象显示名称 | string | 用户/组织架构/角色的显示名称 |
| ├─├─ entityType | 授权对象类型 | string | 取值范围： group: 组织架构 band：角色 user: 用户 |
| ├─├─ userDirectoryId | 用户目录id | string | 用户目录id |
| ├─├─ isDeleted | 外部已删除 | number | 外部已删除 取值范围： 0 - 未删除 1 - 已删除 |
| ├─├─ serverName | 所属用户目录名称 | string | 所属用户目录名称 |
| ├─├─ dataType | 数据类型 | string | 数据类型，例如： externalUserGroup：外部组织架构 localUserBand：本地角色 localUser：本地用户 |
| ├─├─ effectiveTime | 生效时间戳 | string | 生效时间戳 例： 1709222400000 |
| ├─├─ expireTime | 过期时间戳 | string | 过期时间戳 例： 1709222400000 |
| ├─├─ description | 描述信息 | string | 描述信息 |
| ├─├─ authorisedStatus | 授权状态 | number | 授权状态 取值范围： 1 - 永不过期； 2 - 即将过期； 3 - 已过期 |
| msg | 描述信息 | string | 描述信息 |
| traceId | 调用链id | string |
- 返回示例
{
"code": "OK",
"data": {
"count": 4,
"pageCount": 1,
"pageSize": 20,
"pageIndex": 1,
"data": [
{
"id": "5141600b-f276-4919-93a0-162be255f2ce",
"name": "/",
"displayName": "",
"entityType": "group",
"userDirectoryId": "6c97c0d0-db08-11ee-9cc7-6f7f82e11f93",
"isDeleted": 0,
"serverName": "custom_dir",
"dataType": "externalUserGroup",
"effectiveTime": "0",
"expireTime": "0",
"description": "",
"authorisedStatus": 1
},
{
"id": "0fccfc00-dc5f-11ee-931f-a9e941254445",
"name": "本地角色",
"displayName": "",
"entityType": "band",
"userDirectoryId": "1",
"isDeleted": 0,
"serverName": "本地用户目录",
"dataType": "localUserBand",
"effectiveTime": "0",
"expireTime": "0",
"description": "",
"authorisedStatus": 1
},
{
"id": "3e12e620-daf6-11ee-99c1-ad5ce62be579",
"name": "hzm",
"displayName": "hzm",
"entityType": "user",
"userDirectoryId": "1",
"isDeleted": 0,
"serverName": "本地用户目录",
"dataType": "localUser",
"effectiveTime": "1709222400000",
"expireTime": "1709395199999",
"description": "",
"authorisedStatus": 3
},
{
"id": "12b3eb60-dbc7-11ee-8fa8-035bfe34954c",
"name": "张三",
"displayName": "张三",
"entityType": "user",
"userDirectoryId": "1",
"isDeleted": 0,
"serverName": "本地用户目录",
"dataType": "localUser",
"effectiveTime": "1709740800000",
"expireTime": "1709805540999",
"description": "",
"authorisedStatus": 2
}
]
},
"msg": "请求成功",
"traceId": "00bf58d2f1b31b0c"
}
错误码